5. ОФОРМЛЕНИЕ ТЕКСТОВЫХ ДОКУМЕНТОВ В КУРСОВОМ И ДИПЛОМНОМ ПРОЕКТИРОВАНИИ
Виды текстовых документов. Информация в текстовом конструкторско-технологическом документе может быть представлена в виде сплошного текста (технические условия, пояснительные записки, расчеты, программы и методики проведения испытаний, инструкции и др.) или текста, разбитого на графы (спецификации, перечни, ведомости, таблицы и
т.д.). В состав текстового документа может входить графическая информация в виде иллюстраций: чертежей, схем, фотографий. Часть информации может быть представлена на формализованном языке в виде формул, уравнений, алгоритмов и программ.Правила построения, изложения и оформления технических условий устанавливает ГОСТ 2.114-70, пояснительной записки, расчетов, программ и методики испытаний - ГОСТ 2.106-68, отчетов о научно-исследовательских работах - ГОСТ 32-81. Однако значительная часть требований по составлению и оформлению названных документов является общей.
Титульный, заглавный и последующие листы документа. Первым листом текстового документа является титульный лист, который выполняется по ГОСТ 2.105-79. На титульном листе приводятся наименование министерства или ведомства, в систему которого входит организация, разработавшая документ, гриф согласования и утверждения, наименование изделия и документа, подписи разработчиков, год издания документа. За титульным листом помещаются заглавный, а затем последующее листы документа, оформленные рамкой и основной надписью по ГОСТ 2.104-68.
Текст документа разделяется на разделы и подразделы. Разделы должны иметь порядковые номера в пределах всего документа, подразделы - нумерацию в пределах каждого раздела. Номера подразделов состоят из номера раздела и подраздела, разделенных точкой. После номера подраздела также ставится точка. Подразделы могут быть разделены на пункты, пункты - на подпункты.
Пункты имеют порядковую нумерацию в пределах подраздела. Номер пункта состоит из разделенных точками номеров раздела, подраздела и пункта. Подпункты нумеруются в пределах пункта. Обозначение подпункта содержит номер раздела, подраздела, пункта и подпункта. Разделы, подразделы, пункты и подпункты нумеруются арабскими цифрами.
Наименование разделов записывается в виде заголовков (симметрично тексту) прописными буквами, наименование подразделов в виде заголовка с абзаца строчными буквами (кроме первой прописной). Например:
5. РАЗРАБОТКА КОНСТРУКЦИИ МИКРОБЛОКА
5.1. Обоснование компоновочной схемы и выбор метода конструирования.
5.2. Выбор конструкционных материалов.
5.3. Разработка конструкции функциональных узлов.
5.3.1. Выбор типоразмера печатных плат.
5.3.2. Расчет размещения элементов на печатных платах.
5.3.3. Описание конструкции функциональных узлов.
5.4. Расчет показателей конструкции микроблока.
5.5. Описание конструкции микроблока.
В текстовом документе помещают содержание, включающее номера и наименования разделов и подразделов с указанием номеров листов (страниц). Нумерация листов в документе сквозная арабскими цифрами, которые проставляются в правых верхних углах листов. На страницах I (титульный лист) и 2 (аннотация) номер страницы не проставляется.
Способы выполнения текстовых документов. Текстовые документы выполняют одним из следующих способов: машинописным на одной стороне листа через два интервала, рукописные - чертежным шрифтом по ГОСТ 2.304-81 с высотой букв не менее 2,5 мм, типографским и с применением печатающих и графических устройств вывода ЭВМ.
Расстояние от рамки листа до границ текста следует оставлять в начале отрок не менее 5 мм, в конце строк - не менее 3 мм
.Расстояние от верхней или нижней строки текста до верхней или нижней ражи должно быть не менее 10 мм
.Смещение начала строки в абзацах относительно границы текста составляет 15-17 мм.
Вписывать в текстовые документы, изданные машинописным способом, отдельные слова, формулы, условные знаки, а также выполнять иллюстрации следует черной тушью.
Текст документа должен быть кратким, четким и не должен допускать различных толкований.
Наименование изделия при первом упоминании в тексте документа должно совпадать с его наименованием в основном конструкторское документе. В последующем тексте порядок слов в наименовании должен быть прямой, т.е. на первом листе должно стоять определение, а затем название изделия. Наименования, приводимые в тексте и на иллюстрациях, должны быть одинаковыми.
Научно-технические термин, обозначения и определения следует использовать в соответствии с существующими стандартами. При отсутствии стандартных терминов и определений рекомендуется применять общепринятые в научно-технической литературе.
В тексте документа не допускается использовать для одного и того же понятия различные научно-технические термины, близкие по смыслу, а также иностранные слова и термины при наличии равнозначных слов и терминов на русском языке
.Значения физических величин в текстовом документе: должны выражаться в единицах СИ. Единицы физических величин, их наименование, обозначения и правила применения устанавливает ГОСТ 8.417-81.
Обозначение единиц следует писать в строку с числовыми значениями без переноса на следующую строку. Между последней цифрой числа и обозначением единицы необходимо оставлять пробел: 100 Вт. 51 Ом, 80
% 20 К. Исключение составляет обозначение величины с помощью знака, поднятого над строкой (например, 20°). Обозначение величин с предельными отклонениями принято записывать в виде: 100±1 Ом.Буквенные обозначения единиц, входящих в произведение, следует отделять точками на средней линии: Н•м, А•Вб
. Произведение обозначений в знаменателе необходимо заключить в скобки: Вт/(м•К). Не рекомендуется применять более одной косой или горизонтальной черты для обозначения отношений, целесообразно использование отрицательных степеней.Для обозначения кратных и дольных единиц измерения по ГОСТ 8.417-81 используются приставки: тера, гига, мега, кило, гекто, дека, деци, санти, милли, микро, нано, пико. Приставка или ее обозначение пишется слитно с наименованием величины:мегаватт (МВт), киловольт (кВ). Для единиц, образованных как произведение или отношение единиц, приставку следует присоединять к наименованию первой единицы: кПа.с/м.
Аббревиатура в текстовом документе (сокращение по первым буквам слов, например, МПП - многослойная печатная плата) кроме общепринятой должна раскрываться при первом использовании. При большом числе сокращений они выносятся с расшифровкой на отдельный лист с заголовком: "Принятые сокращения". Лист помещается в документе после "Содержания".
Не следует, применять произвольное сокращение слов в тексте документа, кроме общепринятых (т.е. и т.д. и др., г).
Математические знаки
, …, проставляют
перед или между цифрами. Не допускается
использовать их в тексте вместо соответствующих
слов - меньше или равно, не равно, больше или
равно, приблизительно, от и до. Математический
знак минус (-) в тексте перед отрицательными
значениями величин заменяется словом
"минус".
Уравнения и формулы в текстовом документе следует выделять из текста свободными строками. Формулы нумеруют арабскими цифрами в пределах раздела. Номер указывают с правой стороны листа на уровне формулы в круглых скобках. Допускается сквозная нумерация формул в документе. Нумеровать следует формулы, на которые имеются ссылки в тексте.
При обращении к формуле по тексту документа номер формулы в тексте указывается в круглых скобках. Например: "как следует из уравнения (5.1)" ...; "после подстановки в (5.2) числовых значений переменных, получим ...". В конце формулы ставится запятая и при необходимости единицы измерения, например мкГн/м. При расшифровке формулы первая строка начинается со слова "где" без двоеточия после него. Расшифровку значений символов с указанием единиц физических величин и коэффициентов выполняют в той же последовательности, в какой они приведены в формуле. Единицы измерения всех физических величин, входящих в формулу, при необходимости указываются в конце расшифровки каждого элемента формулы после запятой. Например: где С
1 - емкость линии, пФ/м; А1 - расстояние между осями линии, м.Формулы, которые не вписываются в одну строку, размещают на нескольких строках. Перенос части формулы допускается на знаках равенства, сложения, вычитания и умножения. Эти знаки повторяются в начале и конце переноса. На знаке деления перенос не делается. Разрывать в формулах дроби, выражения под радикалами и т.д. не допускается.
Результаты расчетов, выполненные по уравнениям и формулам, следует приводить с указанием исходного выражения в принятой системе буквенных обозначений, подстановкой всех числовых величин и полученного результата. Буквенные обозначения в исходном выражении необходимо расшифровать.
Таблица в текстовом документе является основной формой представлена данных о физических константах, свойствах веществ и материалов. Структура таблицы приведена на рис. 6. Таблица должна иметь номер и заголовок. Таблицы нумеруют последовательно арабскими цифрами в пределах раздела. Номер ставится над правые верхним углом таблицы. Ниже номера над рамкой таблицы приводится заголовок. Таблицу размещают после первого упоминания о ней в тексте таким образом, чтобы ее можно было читать без поворота или с поворотов по часовой стрелке на 90° . При ссылке на таблицу в тексте слово "таблица" может быть заменено сокращением "Табл". Например: "Механические характеристики некоторых конструкционных материалов приведены в табл. 5.1". Если документ содержит только одну таблицу, то ее не нумеруют и слово "таблица" не пишут.

Рис. 6
Иллюстрации в текстовых документах. Количество иллюстраций должно быть достаточным для пояснения излагаемого текста, качество иллюстраций должно обеспечивать их четкое восприятие.
Все иллюстрации (графики, схемы, чертежи, диаграммы, фотографии а т.д.) именуются рисунками. Фотографии размером меньше формата А4 должны быть наклеены на стандартные листы белой бумаги. Рисунки нумеруются последовательно в пределах раздела документа арабскими цифрами. Номер рисунка должен состоять из номера разделе и порядкового номера рисунка, разделенных точкой, например, ряс 3.2 - второй рисунок третьего раздела. Номер рисунка ставить под рисунком в центре или смещается к левому краю при наличии
подрисуночной подписи. В тексте документа должны быть ссылки на приводимые рисунки с указанием их номеров. Например: "Тепловая схема микроблока приведена на рис. 2.6". Рисунки могут выполняться непосредственно на страницах с текстом или на отдельных листах формата А4. В этом случае на одном листе может быть размещено несколько рисунков. В документе рисунки должны располагаться сразу после первого обращения к ним в тексте.Список литература приводится в конце текстового документа под заголовком "Литература". Источники информации в списке следует располагать в порядке появления ссылок в тексте документа. Сведения об источниках, включенных в список, необходимо давать в соответствии с требованиями ГОСТ 7.1-84. ссылки в тексте на источники опускается приводить в подстрочном примечании или указывать порядковый номер по списку литературы в квадратных скобках.
Приложение. В приложения текстового документа включают вспомогательный материал, дополняющей документ: промежуточные математические выкладки, формулы, расчеты, вспомогательные цифровые данные и др. Приложения начинают с нового листа с указанием в правом верхнем углу слова "ПРИЛОЖЕНИЕ", напечатанного прописными буквами, и содержательного заголовка. Приложения нумеруют последовательно арабскими цифрами: "Приложение 1", "Приложение 2" и т.д.
Текст каждого приложения при необходимости может быть раздолен на подразделы и пункты в пределах каждого приложена, перед ними ставится буква П, например П1.2.3 (третий пункт второго подраздела первого приложения). Аналогично нумеруются таблицы, формулы и иллюстрации в пределах каждого приложения.